<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>关闭连接</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="class.mongoclient.html">MongoClient</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="mongoclient.connect.html">MongoClient::connect</a></div>
 <div class="up"><a href="class.mongoclient.html">MongoClient</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongoclient.close" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoClient::close</h1>
  <p class="verinfo">(PECL mongoclient &gt;=0.9.0)</p><p class="refpurpose"><span class="refname">MongoClient::close</span> &mdash; <span class="dc-title">关闭连接</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongoclient.close-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>MongoClient::close</strong></span>
    ([ <span class="methodparam"><span class="type"><span class="type boolean|string">boolean|string</span></span> <code class="parameter">$connection</code></span>
  ] )</div>

  <p class="para rdfs-comment">
   <span class="function"><strong>MongoClient::close()</strong></span> 方法强制关闭一个数据库连接，哪怕使用的是持久连接。
   在正常情况下，你<em class="emphasis">绝不</em>需要这么做。
  </p>
  <p class="para">
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-mongoclient.close-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>

      <em><code class="parameter">connection</code></em>
     </dt>

     <dd>

      <p class="para">
       如果没有指定 connection，或者是 <strong><code>FALSE</code></strong>，将会选择关闭写作操作的连接。
       如果配置为单节点，将会关闭整个连接，但是如果你连接到一个集群，
       close() 会<em class="emphasis">仅仅</em>关闭 primary 节点的连接。
      </p>
      <p class="para">
       如果 connection 是 <strong><code>TRUE</code></strong>，连接管理器将会关闭所有由它管理的连接。
       这也会包括创建对象时所引用的连接字符串之外的连接。
      </p>
      <p class="para">
       如果 connection 是一个字符串参数，它将仅仅关闭由该 hash 标识的连接。
       Hash 是调用 <span class="function"><a href="mongoclient.getconnections.html" class="function">MongoClient::getConnections()</a></span> 所返回，能够表示一个连接。
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongoclient.close-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   返回连接是否成功关闭。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-mongoclient.close-examples">
  <h3 class="title">范例</h3>
  <div class="example" id="example-1368">
   <p><strong>Example #1 <span class="function"><strong>MongoClient::close()</strong></span> 例子</strong></p>
   <div class="example-contents"><p>这个例子演示了如何选择性地仅关闭备份节点的所有连接。</p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">//&nbsp;连接到集群<br /></span><span style="color: #0000BB">$a&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">(</span><span style="color: #DD0000">"mongodb://whisky:13000/?replicaset=seta"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$connections&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$a</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getConnections</span><span style="color: #007700">();<br /><br />foreach&nbsp;(&nbsp;</span><span style="color: #0000BB">$connections&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$con&nbsp;</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #FF8000">//&nbsp;遍历所有连接，如果类型是&nbsp;"SECONDARY"&nbsp;则关闭连接<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">if&nbsp;(&nbsp;</span><span style="color: #0000BB">$con</span><span style="color: #007700">[</span><span style="color: #DD0000">'connection'</span><span style="color: #007700">][</span><span style="color: #DD0000">'connection_type_desc'</span><span style="color: #007700">]&nbsp;==&nbsp;</span><span style="color: #DD0000">"SECONDARY"&nbsp;</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Closing&nbsp;'</span><span style="color: #007700">{</span><span style="color: #0000BB">$con</span><span style="color: #007700">[</span><span style="color: #DD0000">'hash'</span><span style="color: #007700">]}</span><span style="color: #DD0000">':&nbsp;"</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$closed&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$a</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">close</span><span style="color: #007700">(&nbsp;</span><span style="color: #0000BB">$con</span><span style="color: #007700">[</span><span style="color: #DD0000">'hash'</span><span style="color: #007700">]&nbsp;);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #0000BB">$closed&nbsp;</span><span style="color: #007700">?&nbsp;</span><span style="color: #DD0000">"ok"&nbsp;</span><span style="color: #007700">:&nbsp;</span><span style="color: #DD0000">"failed"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />}<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

   <div class="example-contents"><p>以上例程会输出：</p></div>
   <div class="example-contents screen">
<div class="cdata"><pre>
Closing &#039;whisky:13001;X;4948&#039;: ok
</pre></div>
   </div>
  </div>
 </div>


 <div class="refsect1 changelog" id="refsect1-mongoclient.close-changelog">
  <h3 class="title">更新日志</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>版本</th>
       <th>说明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>1.3.0</td>
       <td>
        <p class="para">
         在 1.3.0 版本中，为这个函数添加了 <em><code class="parameter">connection</code></em> 参数。
         在此之前，直邮写入连接才会被这个方法关闭。
        </p>
       </td>
      </tr>

      <tr>
       <td>1.2.0</td>
       <td>
        <p class="para">
         在版本 1.2.0 之前，这个驱动默认不会使用持久连接，所有连接会在作用域结束时关闭。
         由于版本 1.2.0 情况不再如此，所以调用 close 会是一个坏主意，在服务器有较高负载时可能会造成更高的压力。
        </p>
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongoclient.close-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li class="member"><span class="function"><a href="mongoclient.getconnections.html" class="function" rel="rdfs-seeAlso">MongoClient::getConnections()</a> - 返回所有已打开连接的信息</span></li>
  </ul>
 </div>

</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="class.mongoclient.html">MongoClient</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="mongoclient.connect.html">MongoClient::connect</a></div>
 <div class="up"><a href="class.mongoclient.html">MongoClient</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
